<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensorshell;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.File;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.Map;<a name="line.4"></a>
<FONT color="green">005</FONT>    import org.hackystat.sensorbase.resource.sensordata.jaxb.SensorData;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    /**<a name="line.8"></a>
<FONT color="green">009</FONT>     * Provides "middleware" for accumulating and sending notification (sensor)<a name="line.9"></a>
<FONT color="green">010</FONT>     * data to Hackystat. SensorShell has two modes of interaction: command line and<a name="line.10"></a>
<FONT color="green">011</FONT>     * programmatic. <a name="line.11"></a>
<FONT color="green">012</FONT>     * &lt;p&gt; <a name="line.12"></a>
<FONT color="green">013</FONT>     * Command line mode is entered by invoking the main() method, and<a name="line.13"></a>
<FONT color="green">014</FONT>     * is intended to be used as a kind of subshell to which commands to add and<a name="line.14"></a>
<FONT color="green">015</FONT>     * send notification data of various types can be sent. The SensorShell can be invoked<a name="line.15"></a>
<FONT color="green">016</FONT>     * without any additional arguments as follows:<a name="line.16"></a>
<FONT color="green">017</FONT>     * <a name="line.17"></a>
<FONT color="green">018</FONT>     * &lt;pre&gt;java -jar sensorshell.jar&lt;/pre&gt;<a name="line.18"></a>
<FONT color="green">019</FONT>     * <a name="line.19"></a>
<FONT color="green">020</FONT>     * Or you can invoke it with one, two, or three additional arguments:<a name="line.20"></a>
<FONT color="green">021</FONT>     * <a name="line.21"></a>
<FONT color="green">022</FONT>     * &lt;pre&gt;java -jar sensorshell.jar [tool] [sensorshell.properties] [command file]&lt;/pre&gt;<a name="line.22"></a>
<FONT color="green">023</FONT>     * &lt;p&gt;<a name="line.23"></a>
<FONT color="green">024</FONT>     * Programmatic mode involves creating an instance of SensorShell, retrieving the <a name="line.24"></a>
<FONT color="green">025</FONT>     * appropriate command instance (Ping, Add, etc.) and invoking the appropriate method.<a name="line.25"></a>
<FONT color="green">026</FONT>     *<a name="line.26"></a>
<FONT color="green">027</FONT>     * @author    Philip M. Johnson<a name="line.27"></a>
<FONT color="green">028</FONT>     */<a name="line.28"></a>
<FONT color="green">029</FONT>    public class SensorShell implements Shell {<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>      /** The underlying SingleSensorShell or MultiSensorShell. */<a name="line.31"></a>
<FONT color="green">032</FONT>      private Shell shell = null;<a name="line.32"></a>
<FONT color="green">033</FONT>      <a name="line.33"></a>
<FONT color="green">034</FONT>      /**<a name="line.34"></a>
<FONT color="green">035</FONT>       * Constructs a new SensorShell instance that can be provided with<a name="line.35"></a>
<FONT color="green">036</FONT>       * notification data to be sent eventually to a specific user key and host.<a name="line.36"></a>
<FONT color="green">037</FONT>       * The toolName field in the log file name is set to "interactive" if the tool<a name="line.37"></a>
<FONT color="green">038</FONT>       * is invoked interactively and "tool" if it is invoked programmatically.<a name="line.38"></a>
<FONT color="green">039</FONT>       *<a name="line.39"></a>
<FONT color="green">040</FONT>       * @param properties  The sensor properties instance for this run.<a name="line.40"></a>
<FONT color="green">041</FONT>       * @param isInteractive     Whether this SensorShell is being interactively invoked or not.<a name="line.41"></a>
<FONT color="green">042</FONT>       */<a name="line.42"></a>
<FONT color="green">043</FONT>      public SensorShell(SensorShellProperties properties, boolean isInteractive) {<a name="line.43"></a>
<FONT color="green">044</FONT>        this(properties, isInteractive, (isInteractive) ? "interactive" : "tool", null);<a name="line.44"></a>
<FONT color="green">045</FONT>      }<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>      /**<a name="line.48"></a>
<FONT color="green">049</FONT>       * Constructs a new SensorShell instance that can be provided with<a name="line.49"></a>
<FONT color="green">050</FONT>       * notification data to be sent eventually to a specific user key and host.<a name="line.50"></a>
<FONT color="green">051</FONT>       *<a name="line.51"></a>
<FONT color="green">052</FONT>       * @param properties  The sensor properties instance for this run.<a name="line.52"></a>
<FONT color="green">053</FONT>       * @param isInteractive     Whether this SensorShell is being interactively invoked or not.<a name="line.53"></a>
<FONT color="green">054</FONT>       * @param tool          Indicates the invoking tool that is added to the log file name.<a name="line.54"></a>
<FONT color="green">055</FONT>       */<a name="line.55"></a>
<FONT color="green">056</FONT>      public SensorShell(SensorShellProperties properties, boolean isInteractive, String tool) {<a name="line.56"></a>
<FONT color="green">057</FONT>        this(properties, isInteractive, tool, null);<a name="line.57"></a>
<FONT color="green">058</FONT>      }<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>      /**<a name="line.61"></a>
<FONT color="green">062</FONT>       * Constructs a new SensorShell instance that can be provided with<a name="line.62"></a>
<FONT color="green">063</FONT>       * notification data to be sent eventually to a specific user key and host.<a name="line.63"></a>
<FONT color="green">064</FONT>       *<a name="line.64"></a>
<FONT color="green">065</FONT>       * @param properties   The sensor properties instance for this run.<a name="line.65"></a>
<FONT color="green">066</FONT>       * @param isInteractive Whether this SensorShell is being interactively invoked or not.<a name="line.66"></a>
<FONT color="green">067</FONT>       * @param toolName  The invoking tool that is added to the log file name.<a name="line.67"></a>
<FONT color="green">068</FONT>       * @param commandFile A file containing shell commands, or null if none provided.<a name="line.68"></a>
<FONT color="green">069</FONT>       */<a name="line.69"></a>
<FONT color="green">070</FONT>      public SensorShell(SensorShellProperties properties, boolean isInteractive, String toolName,<a name="line.70"></a>
<FONT color="green">071</FONT>          File commandFile) {<a name="line.71"></a>
<FONT color="green">072</FONT>        if (properties.isMultiShellEnabled()) {<a name="line.72"></a>
<FONT color="green">073</FONT>          // Note that isInteractive, commandFile are ignored if MultiSensorShell is specified.<a name="line.73"></a>
<FONT color="green">074</FONT>          shell = new MultiSensorShell(properties, toolName);<a name="line.74"></a>
<FONT color="green">075</FONT>        }<a name="line.75"></a>
<FONT color="green">076</FONT>        else {<a name="line.76"></a>
<FONT color="green">077</FONT>          shell = new SingleSensorShell(properties, isInteractive, toolName, commandFile);<a name="line.77"></a>
<FONT color="green">078</FONT>        }<a name="line.78"></a>
<FONT color="green">079</FONT>      }<a name="line.79"></a>
<FONT color="green">080</FONT>      <a name="line.80"></a>
<FONT color="green">081</FONT>      /** {@inheritDoc} */<a name="line.81"></a>
<FONT color="green">082</FONT>      public void add(Map&lt;String, String&gt; keyValMap) throws SensorShellException {<a name="line.82"></a>
<FONT color="green">083</FONT>        this.shell.add(keyValMap);<a name="line.83"></a>
<FONT color="green">084</FONT>      }<a name="line.84"></a>
<FONT color="green">085</FONT>      <a name="line.85"></a>
<FONT color="green">086</FONT>      /** {@inheritDoc} */<a name="line.86"></a>
<FONT color="green">087</FONT>      public void add(SensorData sensorData) throws SensorShellException {<a name="line.87"></a>
<FONT color="green">088</FONT>        this.shell.add(sensorData);<a name="line.88"></a>
<FONT color="green">089</FONT>      }<a name="line.89"></a>
<FONT color="green">090</FONT>      <a name="line.90"></a>
<FONT color="green">091</FONT>      /** {@inheritDoc} */<a name="line.91"></a>
<FONT color="green">092</FONT>      public int send() throws SensorShellException {<a name="line.92"></a>
<FONT color="green">093</FONT>        return this.shell.send();<a name="line.93"></a>
<FONT color="green">094</FONT>      }<a name="line.94"></a>
<FONT color="green">095</FONT>      <a name="line.95"></a>
<FONT color="green">096</FONT>      /** {@inheritDoc} */<a name="line.96"></a>
<FONT color="green">097</FONT>      public void quit() throws SensorShellException {<a name="line.97"></a>
<FONT color="green">098</FONT>        this.shell.quit();<a name="line.98"></a>
<FONT color="green">099</FONT>      }<a name="line.99"></a>
<FONT color="green">100</FONT>      <a name="line.100"></a>
<FONT color="green">101</FONT>      /** {@inheritDoc} */<a name="line.101"></a>
<FONT color="green">102</FONT>      public boolean hasOfflineData() {<a name="line.102"></a>
<FONT color="green">103</FONT>        return this.shell.hasOfflineData();<a name="line.103"></a>
<FONT color="green">104</FONT>      }<a name="line.104"></a>
<FONT color="green">105</FONT>      <a name="line.105"></a>
<FONT color="green">106</FONT>      /** {@inheritDoc} */<a name="line.106"></a>
<FONT color="green">107</FONT>      public boolean ping() {<a name="line.107"></a>
<FONT color="green">108</FONT>        return this.shell.ping();<a name="line.108"></a>
<FONT color="green">109</FONT>      }<a name="line.109"></a>
<FONT color="green">110</FONT>      <a name="line.110"></a>
<FONT color="green">111</FONT>      /** {@inheritDoc} */<a name="line.111"></a>
<FONT color="green">112</FONT>      public SensorShellProperties getProperties() {<a name="line.112"></a>
<FONT color="green">113</FONT>        return this.shell.getProperties();<a name="line.113"></a>
<FONT color="green">114</FONT>      }<a name="line.114"></a>
<FONT color="green">115</FONT>      <a name="line.115"></a>
<FONT color="green">116</FONT>      /** {@inheritDoc} */<a name="line.116"></a>
<FONT color="green">117</FONT>      public void statechange(long resourceCheckSum, Map&lt;String, String&gt; keyValMap) throws Exception {<a name="line.117"></a>
<FONT color="green">118</FONT>        this.shell.statechange(resourceCheckSum, keyValMap);<a name="line.118"></a>
<FONT color="green">119</FONT>      }<a name="line.119"></a>
<FONT color="green">120</FONT>      <a name="line.120"></a>
<FONT color="green">121</FONT>      /**<a name="line.121"></a>
<FONT color="green">122</FONT>       * The command line shell interface for invoking a single sensor shell interactively.<a name="line.122"></a>
<FONT color="green">123</FONT>       * &lt;ul&gt;<a name="line.123"></a>
<FONT color="green">124</FONT>       *   &lt;li&gt; If invoked with no arguments, then the default sensorshell.properties<a name="line.124"></a>
<FONT color="green">125</FONT>       *   file is used and the toolName field in the sensor log file name is<a name="line.125"></a>
<FONT color="green">126</FONT>       *   "interactive".<a name="line.126"></a>
<FONT color="green">127</FONT>       *   &lt;li&gt; If invoked with one argument, that argument is used as the toolName<a name="line.127"></a>
<FONT color="green">128</FONT>       *   value.<a name="line.128"></a>
<FONT color="green">129</FONT>       *   &lt;li&gt; If invoked with two arguments, then <a name="line.129"></a>
<FONT color="green">130</FONT>       *   the second is used as the sensorshell.properties file<a name="line.130"></a>
<FONT color="green">131</FONT>       *   path.<a name="line.131"></a>
<FONT color="green">132</FONT>       *   &lt;li&gt; If invoked with three arguments, then the <a name="line.132"></a>
<FONT color="green">133</FONT>       *   the third argument specifies a file of commands (the last of which should be 'quit').<a name="line.133"></a>
<FONT color="green">134</FONT>       * &lt;/ul&gt;<a name="line.134"></a>
<FONT color="green">135</FONT>       * Unless three arguments are provided,<a name="line.135"></a>
<FONT color="green">136</FONT>       * the shell then provides a "&gt;&gt;" prompt and supports interactive entry of<a name="line.136"></a>
<FONT color="green">137</FONT>       * sensor data. The following commands are supported:<a name="line.137"></a>
<FONT color="green">138</FONT>       * &lt;ul&gt;<a name="line.138"></a>
<FONT color="green">139</FONT>       *   &lt;li&gt; "help" provides a summary of the available commands.<a name="line.139"></a>
<FONT color="green">140</FONT>       *   &lt;li&gt; "send" sends all of the accumulated data to the server.<a name="line.140"></a>
<FONT color="green">141</FONT>       *   &lt;li&gt; "quit" sends all of the accumulated data to the server and exits.<a name="line.141"></a>
<FONT color="green">142</FONT>       *   &lt;li&gt; "ping" checks to see if the host/user/password is valid. <a name="line.142"></a>
<FONT color="green">143</FONT>       *   &lt;li&gt; "add" adds a single Sensor Data instance to the buffered list to send.<a name="line.143"></a>
<FONT color="green">144</FONT>       * &lt;/ul&gt;<a name="line.144"></a>
<FONT color="green">145</FONT>       *<a name="line.145"></a>
<FONT color="green">146</FONT>       * @param args  The command line parameters. See above for details.<a name="line.146"></a>
<FONT color="green">147</FONT>       * @throws SensorShellException If problems occur sending data. <a name="line.147"></a>
<FONT color="green">148</FONT>       */<a name="line.148"></a>
<FONT color="green">149</FONT>      public static void main(String args[]) throws SensorShellException {<a name="line.149"></a>
<FONT color="green">150</FONT>        // Print help line and exit if arg is -help.<a name="line.150"></a>
<FONT color="green">151</FONT>        if ((args.length == 1) &amp;&amp; (args[0].equalsIgnoreCase("-help"))) {<a name="line.151"></a>
<FONT color="green">152</FONT>          System.out.println("java -jar sensorshell.jar [tool] [sensorshell.properties] [commandfile]");<a name="line.152"></a>
<FONT color="green">153</FONT>          return;<a name="line.153"></a>
<FONT color="green">154</FONT>        }<a name="line.154"></a>
<FONT color="green">155</FONT>        <a name="line.155"></a>
<FONT color="green">156</FONT>        // Set Parameter 1 (toolname) to supplied or default value.<a name="line.156"></a>
<FONT color="green">157</FONT>        String toolName = (args.length &gt; 0) ? args[0] : "interactive";<a name="line.157"></a>
<FONT color="green">158</FONT>    <a name="line.158"></a>
<FONT color="green">159</FONT>        // Set Parameter 2 (sensorshell.properties file) to supplied or default value. Exit if error.<a name="line.159"></a>
<FONT color="green">160</FONT>        SensorShellProperties sensorProps = null;<a name="line.160"></a>
<FONT color="green">161</FONT>        try {<a name="line.161"></a>
<FONT color="green">162</FONT>          sensorProps = (args.length &gt;= 2) ?<a name="line.162"></a>
<FONT color="green">163</FONT>              new SensorShellProperties(new File(args[1])) : new SensorShellProperties();<a name="line.163"></a>
<FONT color="green">164</FONT>        }<a name="line.164"></a>
<FONT color="green">165</FONT>        catch (SensorShellException e) {<a name="line.165"></a>
<FONT color="green">166</FONT>          System.out.println(e.getMessage());<a name="line.166"></a>
<FONT color="green">167</FONT>          System.out.println("Exiting...");<a name="line.167"></a>
<FONT color="green">168</FONT>          return;<a name="line.168"></a>
<FONT color="green">169</FONT>        }<a name="line.169"></a>
<FONT color="green">170</FONT>    <a name="line.170"></a>
<FONT color="green">171</FONT>        // Set Parameter 3 (command file). Null if not supplied. Exit if supplied and bogus.<a name="line.171"></a>
<FONT color="green">172</FONT>        File commandFile = null;<a name="line.172"></a>
<FONT color="green">173</FONT>        if (args.length == 3) {<a name="line.173"></a>
<FONT color="green">174</FONT>          commandFile = new File(args[2]);<a name="line.174"></a>
<FONT color="green">175</FONT>          if (!(commandFile.exists() &amp;&amp; commandFile.isFile())) {<a name="line.175"></a>
<FONT color="green">176</FONT>            System.out.println("Could not find the command file. Exiting...");<a name="line.176"></a>
<FONT color="green">177</FONT>            return;<a name="line.177"></a>
<FONT color="green">178</FONT>          }<a name="line.178"></a>
<FONT color="green">179</FONT>        }<a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>        // Set interactive parameter. From command line, always interactive unless using command file.<a name="line.181"></a>
<FONT color="green">182</FONT>        boolean interactive = ((commandFile == null));<a name="line.182"></a>
<FONT color="green">183</FONT>    <a name="line.183"></a>
<FONT color="green">184</FONT>        // Now create the (single) shell instance, supplying it with all the appropriate arguments.<a name="line.184"></a>
<FONT color="green">185</FONT>        SingleSensorShell shell = <a name="line.185"></a>
<FONT color="green">186</FONT>          new SingleSensorShell(sensorProps, interactive, toolName, commandFile);<a name="line.186"></a>
<FONT color="green">187</FONT>    <a name="line.187"></a>
<FONT color="green">188</FONT>        // Start processing commands either interactively or from the command file.<a name="line.188"></a>
<FONT color="green">189</FONT>        while (true) {<a name="line.189"></a>
<FONT color="green">190</FONT>          // Get the next command<a name="line.190"></a>
<FONT color="green">191</FONT>          shell.printPrompt();<a name="line.191"></a>
<FONT color="green">192</FONT>          String inputString = shell.readLine();<a name="line.192"></a>
<FONT color="green">193</FONT>          shell.processInputString(inputString);<a name="line.193"></a>
<FONT color="green">194</FONT>          if (inputString.equalsIgnoreCase("quit")) {<a name="line.194"></a>
<FONT color="green">195</FONT>            return;<a name="line.195"></a>
<FONT color="green">196</FONT>          }<a name="line.196"></a>
<FONT color="green">197</FONT>        }<a name="line.197"></a>
<FONT color="green">198</FONT>      }<a name="line.198"></a>
<FONT color="green">199</FONT>    <a name="line.199"></a>
<FONT color="green">200</FONT>    }<a name="line.200"></a>
<FONT color="green">201</FONT>    <a name="line.201"></a>




























































</PRE>
</BODY>
</HTML>
